Platform Explorer / Nuxeo Platform 2023.20

Component org.nuxeo.ecm.platform.url.service.DocumentViewCodecService.contrib

In bundle org.nuxeo.ecm.platform.url

Documentation

Contributions for basic rest navigation through the application.

@version 1.0

Resolution Order

558
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Contributions

XML Source

<?xml version="1.0"?>

<component
  name="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService.contrib">
  <documentation>
    Contributions for basic rest navigation through the application.

    @version 1.0
    @author Anahide Tchertchian (at@nuxeo.com)
  </documentation>

  <extension
    target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService"
    point="codecs">
    <documentation>
      The docid codec uses the document uid to resolve the context. Urls are of
      the form http://site/nuxeo/nxdoc/demo/docuid/view.

      The docpath codec uses the document path to resolve the context. Urls are
      of the form http://site/nuxeo/nxpath/demo/path/to/my/doc@view.

      The document file codec uses the document uid to resolve the document
      model and extract a file held in its properties. Urls are of the form
      http://site/nuxeo/nxfile/demo/docuid/file:content/mydoc.odt.

      We declare three codecs using this same class but different prefixes
      (nxfile, nxeditfile,...) so that we can define several url patterns,
      performing different actions, but still using the same syntax.
    </documentation>
    <documentViewCodec name="docid" enabled="true" default="true" prefix="nxdoc"
      class="org.nuxeo.ecm.platform.url.codec.DocumentIdCodec" />
    <documentViewCodec name="docpath" enabled="true" default="false"
      prefix="nxpath"
      class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" />
    <documentViewCodec name="editFile" enabled="true" prefix="nxeditfile"
      class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" />
    <documentViewCodec name="pdfFile" enabled="true" prefix="nxpdffile"
      class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" />
  </extension>


</component>